home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / searchtools / oasisIII.README < prev    next >
Text File  |  1994-08-01  |  24KB  |  598 lines
  1.  
  2.                       ~4Dgifts/toolbox/sifttree README
  3.  
  4.     sifttree is a script that first fires up a server program, oksvr, and
  5.     then invokes a client graphical interface program, oasisIII, used for
  6.     information retrieval.  oasisIII/oksvr are a client/server relationship.
  7.     Together they provide a powerful search mechanism for examining keywords,
  8.     titles, filenames throughout the entire Toolbox tree.
  9.  
  10.     Note that as of version 4.1 of the toolbox, sifttree contains index 
  11.     database file on the ENTIRE contents of this CD.  when the OasisIII 
  12.     window comes up, you will notice that only the "Source" and "Toolbox"
  13.     nodes are active--this is so that by default, the whole tree is searched.
  14.  
  15.     When quitting out of oasisIII, you'll need to wait about one minute before 
  16.     successfully starting up sifttree again.  As explained by an in-house 
  17.     netgaud, when asked, What is this 1 minute delay?  It's a TCP thing--in 
  18.     order to be "a reliable delivery mechanism", tcp says it has to wait 
  19.     around a bit after it wants to die so clients can flush themselves.  The 
  20.     behavior one will see if one *doesn't* wait long enugg will be the message,
  21.  
  22. INITREQMSG: Send Communication Error
  23.     
  24.     coming out in the shell window sifttree was invoked from, and a notifier
  25.     window which will come up saying
  26.  
  27. Initialization failed.
  28.  
  29. Problem communicating with server process (oksvr)
  30. on host localhost
  31.  
  32.     Again, wait one minute and then invoke sifttree again. 
  33.  
  34.     Remember, the program oksvr that first gets started inside the sifttree
  35.     script is a server--once it's fired up, it will continue to run until you 
  36.     exit the OasisIII window.  As long as oksvr is running there will be a 
  37.     file, /usr/tmp/ft*.tmp, that is used as a memory nexus.  As long as oksvr 
  38.     is "properly" terminated (i.e. exiting OasisIII), this file will 
  39.     automatically be removed.
  40.  
  41.     If you find you are unable to fire up [xpsview-]viewing of a PostScript 
  42.     file listed in the Documents Area (bottom part of the window), and you
  43.     see the message:
  44. The X11 Server DPS/X extension failed to initialize,
  45. please check the dps_eoe release notes for recommendations.
  46.     come up in the xwsh you fired up sifttree from, you will need to:
  47.         From your 5.1 or 5.1.1 installation CDROM:
  48.  
  49.         # inst -f /CDROM/dist/x_eoe
  50.  
  51.         Inst> k *
  52.         Inst> install x_eoe.sw.xdps
  53.         Inst> go
  54.         Inst> quit
  55.  
  56.  
  57.  
  58.     follows is an ascii text form of information about operating oasisIII:
  59.   ____________________________________________________________________________
  60.  
  61.  
  62.  
  63.     OasisIII starts a graphical interface used for information retrieval.  
  64.     It allows searching various user-selected databases for keywords.  The 
  65.     program uses a TCP/IP socket to connect to a server process which 
  66.     performs the actual searches, and returns results.  The file ~/.oasisrc
  67.     is read when oasisIII starts for initialization information, such as 
  68.     the server's hostname, default window parameters, maximum hits per 
  69.     search, and more.  A template file of oasisrc is found in 
  70.     /usr/lib/OasisIII.  These entries are not intended to be modified 
  71.     manually, and should instead be manipulated via the Preferences option 
  72.     of the main window.
  73.  
  74.  
  75.     The topics that follow breakdown thusly:
  76.     OasisIII Application - Main Window
  77.     OasisIII - Menubar
  78.     OasisIII - Inquiry Area
  79.     OasisIII - Inquiry Area - Graphical Tree Browsing
  80.     OasisIII - Graphical Tree Controls
  81.     OasisIII - List Browsing
  82.     OasisIII - Search Controls
  83.     OasisIII - Searching / Additional Fields
  84.     OasisIII - Search Syntax
  85.     OasisIII - Documents Area
  86.     OasisIII - Information (Document) Viewer
  87.     OasisIII - Information (Document) Viewer Functions
  88.     OasisIII - Settings Window
  89.     OasisIII - Folder Manager
  90.     OasisIII - Folder Manager Functions
  91.  
  92.  
  93.  
  94.  
  95.  
  96.     OasisIII Application - Main Window
  97.     --------------------------------------------------------------------
  98. This window is used to retrieve information from a database of indexed
  99. document databases. It is the main window that the user interacts with.
  100.  
  101. This is the primary window that is invoked when this application is started
  102. from the command line;  or initiated from the SGI WorkSpace.
  103.  
  104. Due to the abundance of functionality present on this window, the
  105. description of commands and interaction is broken into three sections:
  106. ________________________________________________________________________
  107.  
  108.  
  109.  
  110.  
  111.  
  112.     OasisIII - Menubar
  113.     --------------------------------------------------------------------
  114. This section describes the commands available from the OasisIII Window
  115. menubar.  To access any menu, the user places the cursor over the desired 
  116. item and clicks the left mouse button.  A menu drops down.  The user then 
  117. places the cursor over the desired command they wish to perform from the 
  118. menu and clicks on that entry.
  119.  
  120. "Session" allows you to terminate an OasisIII application session.
  121.  
  122. "Inquiry" allows the user to control the view that is displayed in
  123. the Inquiry area (tree+additional query criteria) of OasisIII.
  124.  
  125. "Documents" allows you to interact with entries displayed in the
  126. multiple-selection document list box, found at the bottom of the
  127.  
  128. Menu    Submenu    Description
  129. ----    -------    -----------
  130. Session
  131.     Quit      Terminates the OasisIII Application. Upon quitting, all
  132.         appropriate state information will be saved in ~/.oasisrc.
  133.  
  134. Inquiry
  135.     Source: [] Graphical View  [] List View
  136.     Topic:  [] Graphical View  [] List View
  137.  
  138.         Toggle allowing the user to switch the tree view they are
  139.         currently accessing and to toggle between viewing the tree
  140.         in graphical form or in list form.
  141.  
  142.         "Source" is meant to give the user a view of actual sources
  143.         that they have available. "Topic" is an abstract view of the
  144.         the information available. It will dynamically construct a
  145.         query based upon the path through the Topic tree that the
  146.         user has chosen.
  147.  
  148. Documents
  149.     Print
  150.     Fax...
  151.     Email...
  152.         For any documents that are in a selected (hilited) state in
  153.         the Document Area list, the user invoke these actions, without
  154.         having to display the document. The user will be prompted for
  155.         more information on entry that is followed by "...".
  156.  
  157.     Sort By: [] Occurrence [] Source  [] Date
  158.         Used as sort criteria for the list of documents returned
  159.         from a search. If a list of documents already exist and
  160.         this is toggled, the list will resort using the new criteria.
  161.  
  162.     Close All
  163.         Closes all Information Viewers currently open.
  164.  
  165. Preferences
  166.     Settings...
  167.         Produces a dialog that displays all current settings for
  168.         the application and allows the user to modify them. See
  169.         See "OasisIII-Settings Window" for further information.
  170.  
  171.     Folder...
  172.         Produces a dialog that displays to the user all current
  173.         inquiries they have saved and all bookmarks they have set.
  174.         See "OasisIII-Folder Window" for further information.
  175. ________________________________________________________________________
  176.  
  177.  
  178.  
  179.  
  180.  
  181.     OasisIII - Inquiry Area
  182.     --------------------------------------------------------------------
  183. From a global perspective, this area allows you to navigate sources or
  184. topics, provide additional keywords, and search across a set of information.
  185.  
  186. Within the navigational region, the user has the capability to browse
  187. information in a tree form by Source or by Topic, to view this information
  188. in Graphical or List form, and access a set of tools that perform specific
  189. tasks upon the tree.
  190.  
  191. Note that this area contains a help message that indicates to the user how
  192. to operate on the tree. This message changes to reflect to the user if they
  193. are viewing a Topic tree, or a Source tree. The message informs the user to
  194. "Click to select <SOURCES or TOPICS>; double-click to expand/contract".  This
  195. message is relevant whether the user is browsing in graphical or list mode.
  196.  
  197. The user can select nodes in the tree, apply any additional query criteria,
  198. and perform a search from within the controls of the Inquiry Area.
  199. ________________________________________________________________________
  200.  
  201.  
  202.  
  203.  
  204.  
  205.     OasisIII - Inquiry Area - Graphical Tree Browsing
  206.     --------------------------------------------------------------------
  207. The user is presented with a graphical "tree" that contains labelled nodes
  208. connected by arcs. This tree represents a logical representation of the
  209. present within the user's view of the knowledge database, or of concepts
  210. (topics) that may be relevant to this user.  All nodes are connected by a
  211. central, or root, node.
  212.  
  213. To expand the nodes of the tree, the user double-clicks on a node, which
  214. produces a list of its immediate children. Double-clicking on a node that
  215. is expanded will collapse it. Nodes that can be expanded contain both a
  216. label, as well as an inverted-triangle symbol (|>).
  217.  
  218. Placing the cursor over any node and clicking the right mouse button
  219. produces a popup menu containing the following commands:
  220.  
  221.     Collapse Subgraph    -Fully collapses the subtree from that node
  222.     Show Immediate Children    -Expands tree out one level from that node
  223.     Show All Children    -Fully expands the subtree from that node
  224.     Search            -Generates a list of documents that
  225.                   correspond to that particular node
  226.     Quick Help        -Invokes a quick help card
  227.  
  228. The first three commands will be greyed if a node has no children.
  229.  
  230. Clicking once on any node places it in a selected state. The node will
  231. turn a specific color to denote that it is currently in that state.
  232. Clicking on a selected node turns off the selection.
  233.  
  234. The user can also "rubber-band" groups of nodes in a put them in a
  235. selected (or unselected) state. Click in the "open area" (NOT on a
  236. node or arc) and hold down the left mouse button to enact this mechanism.
  237.  
  238. Clicking out in the general tree area (not over a node) with the right
  239. mouse button produces a popup menu that operates on all nodes that are
  240. in a SELECTED state. The following commands are available:
  241.  
  242.     Search                -Generates a list of documents for those
  243.                  nodes that are selected
  244.     Quick Help        -Invokes a quick help card
  245. ________________________________________________________________________
  246.  
  247.  
  248.  
  249.  
  250.  
  251.     OasisIII - Graphical Tree Controls
  252.     --------------------------------------------------------------------
  253. The first three controls in the palette deal with zooming the tree.
  254. First is an options-button, labelled with a set of percentages. When the
  255. graph first comes up, this entry is 100%. The user can access this menu
  256. to produce a list of percentages that act as "zoom factors". These range
  257. between 15% and 300%. The font used for the label on the node will scale
  258. up/down, the arcs change to reflect the larger/smaller nodes, and the
  259. tree positions itself according to the centermost node. Up- and Down-arrows
  260. that follow the options-button will move the tree through the zoom factors
  261. in the order they occur in the menu. For example, if the user were to
  262. click on the Up-arrow 3 times, the resultant zoom pattern would be
  263. 150%-200%-300%.
  264.  
  265. The next control available in the palette is an "Overview" button. This
  266. produces a separate window that shows the user the entire tree in a block
  267. diagram. The window contains a hollow-rectangle that overlays the diagram,
  268. showing the current viewable region of the tree. The user can click on
  269. the rectangle and postion it over a portion of the tree they wish to see.
  270. The view in the OasisIII-Window will reflect that portion of the tree, in
  271. real-time. Both sizing the OasisIII-Window and scrolling via the scrollbars
  272. on the tree will also cause an update to the overview window.
  273.  
  274. Finally, the user may wish to rotate the tree so that it appears in a
  275. top-down(vertical) versus left-right (horizontal-the default) style
  276. of presentation. The control that provides that functionality is the
  277. "Rotate" button (LAST button in the pallete).
  278. ________________________________________________________________________
  279.  
  280.  
  281.  
  282.  
  283.  
  284.     OasisIII - List Browsing
  285.     --------------------------------------------------------------------
  286. The user can traverse through the various Sources of information or
  287. Topics in a list manner. To toggle this option use the "Inquiry" menu.
  288.  
  289. Navigating through a list-oriented tree is similar to navigating the
  290. graphical representation of the tree.
  291.  
  292. List entries that can be expanded are followed by a textual symbol of ">>".
  293. Double-click expands (contracts) the list entries in-line, displaying
  294. (removing) their children.
  295.  
  296. A single-click selects that entry. Turning off the selection is done
  297. by clicking again on that selected entry.
  298.  
  299. Placing the cursor over any node and clicking the right mouse button
  300. produces a popup menu containing the following commands:
  301.  
  302.         Collapse Children       -Fully collapses the subtree from that
  303. node
  304.         Show Immediate Children -Expands tree out one level from that node
  305.         Show All Children       -Fully expands the subtree from that node
  306.         Search                  -Generates a list of documents that
  307.                                  correspond to that particular node
  308.         Quick Help              -Invokes a quick help card
  309.  
  310. The first three commands will be greyed if a node has no children.
  311.  
  312. Clicking out in the general tree area (not over a node) with the right
  313. mouse button produces a popup menu that operates on all nodes that are
  314. in a SELECTED state. The following commands are available:
  315.  
  316.         Search                  -Generates a list of documents for those
  317.                                  nodes that are selected
  318.         Quick Help              -Invokes a quick help card
  319. ________________________________________________________________________
  320.  
  321.  
  322.  
  323.  
  324.  
  325.     OasisIII - Search Controls
  326.     --------------------------------------------------------------------
  327. Following the additional fields, there is are controls that work in
  328. conjunction with the search operation.
  329.  
  330. Control        Description
  331. -------         -----------
  332. Search        Performs a search using Topic and/or Source information
  333.         AND any additional field information.
  334.  
  335. Narrow        Search a previously retrieved set of documents. This
  336.         inquiry only searches against that set.
  337.  
  338. Save         Save all search criteria (including tree information).
  339.         You will be prompted to provide a "user label" to assign
  340.         to this saved inquiry. For re-invocation, see "Folder Manager".
  341.  
  342. Clear        Clears out the edit fields only. Does not reset the tree
  343.         information, nor erase a document set retrieved via a search.
  344. ________________________________________________________________________
  345.  
  346.  
  347.  
  348.  
  349.  
  350.     OasisIII - Searching / Additional Fields
  351.     --------------------------------------------------------------------
  352. "Enter" from any field will cause a search to be performed. For information
  353. on Search Syntax, see "OasisIII - Search Syntax".
  354.  
  355. Field        Description
  356. -----         -----------
  357. Keywords    Searches the "generic" content of all documents.
  358.  
  359. Title        Only searches in the document title string. Very fast
  360.         search. Good for delimiting/narrowing.
  361.  
  362. Filename        Searches in the document filename field.  Could search
  363.         with just extensions, or any part of the file (or file
  364.         path) specified.
  365.  
  366. Date        Accepts a date string in virtually any format. Will do
  367.         its best to convert it and look for documents that have
  368.             date values that fall into the specified range. To ensure
  369.         proper conversion, "YYMMDD" is a form that works.
  370. ________________________________________________________________________
  371.  
  372.  
  373.  
  374.  
  375.  
  376.     OasisIII - Search Syntax
  377.     --------------------------------------------------------------------
  378. Besides producing documents via the browsing methods, users may also
  379. use the additional fields to qualify their searches further.  These
  380. additional fields support full boolean constructs. Users may define
  381. queries using any combination of ANDs, ORs, NOTs, and paranthetical
  382. expressions. For example, to find documents that deal with tape drives
  383. and also find any documents dealing with non-scsi disk errors, the
  384. user could formulate the following query:
  385.  
  386.     (TAPE and DRIVE) or (NOT SCSI and (DISK and ERROR)).
  387.  
  388. Note that the system also supports the following operators:
  389.  
  390.     [term1 term2]    -Proximity-find documents containing the terms
  391.                 a set distance from each other.
  392.     "term1 term2"    -Phrase-find documents containing both terms
  393.                 in the given order, next to each other.
  394.     term*        -Expansion-look for any document with word(s)
  395.                     containing the base term.
  396.     term?        -Wildcard-find any document with word(s)
  397.                 containing the base term and any
  398.                   ONE character following that term.
  399.  
  400.  
  401. Notes: " " (blank space) is a logical AND condition.
  402. ________________________________________________________________________
  403.  
  404.  
  405.  
  406.  
  407.  
  408.     OasisIII - Documents Area
  409.     --------------------------------------------------------------------
  410. This area of the Knowledge Retrieval Window is used to display the list
  411. of documents that results from a search, and a count of how many were found.
  412. Items from the list of found documents can be selected, sorted, displayed,
  413. or sent to other output channels.
  414.  
  415. The Documents Section is located at the bottom of the OasisIII window.
  416. Note that this area is a Motif "pane", capable of being independently
  417. collapsed/sized within the entire window. Click on the rectangle above
  418. and to the right of the list. Hold the mouse button down and drag the
  419. pane up or down. Note the change in size/layout.
  420.  
  421. Below the text labels that indicate the number of documents found via a
  422. search and a simple help message, is a scrollable(horizontal and vertical),
  423. multiple-selection list containing titles of the documents retrieved via
  424. a search.
  425.  
  426. The results are sorted as specified by the user and can be changed from
  427. within the "Documents" menu. See "OasisIII - Menubar" for more information.
  428.  
  429. A scrollbar allows scrolling through the list.  The user can single click
  430. the left mouse button on an entry in the list, to select that entry. This
  431. causes that entry to be hilited. The user may perform actions on the set
  432. of documents that have been selected, by using the actions in the "Documents"
  433. menu. Subsequent single, left-mouse clicks on selected items cause the
  434. item to become "unselected".
  435.  
  436. Double-clicking the left mouse button on an entry in the list causes that
  437. item to be displayed, either in the current active viewer window (if one
  438. is in use), or in a newly-created viewer window (see "OasisIII-Information
  439. Viewer").
  440. ________________________________________________________________________
  441.  
  442.  
  443.  
  444.  
  445.  
  446.     OasisIII - Information (Document) Viewer
  447.     --------------------------------------------------------------------
  448. This window is used to view (read, browse, ...) documents. It is displayed
  449. via a double-click on a document in the OasisIII window Document List that
  450. was retrieved from a search; or it can be invoked from a bookmark entry in
  451. the Folder Manager Window. Note that the document is not editable.
  452. ________________________________________________________________________
  453.  
  454.  
  455.  
  456.  
  457.  
  458.     OasisIII - Information (Document) Viewer Functions
  459.     --------------------------------------------------------------------
  460. Menu    Submenu Description
  461. ----    ------- -----------
  462. Session
  463.         Quit    Closes the current Information Viewer (only).
  464.  
  465. Documents
  466.      Copy..., Email..., Fax..., Print
  467.         For the document currently in the Viewer, the desired action
  468.         will be performed. The user will be prompted for more
  469.                 information on entry that is followed by "...".
  470.     Search
  471.         Will perform an in-document search using the string that
  472.         the user provides. Terms found within the document will be
  473.         shown in a different color both in the scrollbar area as
  474.         well as within the document.
  475.     Bookmark
  476.         Will prompt the user for a label to assign to this document.
  477.         Bookmark entries can be accessed/invoked via the Folder
  478.         Manager.
  479. ________________________________________________________________________
  480.  
  481.  
  482.  
  483.  
  484.  
  485.     OasisiIII Information Viewer Functions
  486.     --------------------------------------------------------------------
  487. Control Area
  488.  
  489. Scrolling is provided via Motif horizontal and vertical scroll bars. The
  490. colors in the scrollbar area indicate the presence of search terms. One
  491. color is used to denote the search criteria used in the OasisIII window,
  492. and another for the in-document search terms. The window will automatically
  493. scroll to the first area that contains search terms.
  494.  
  495. Keywords: Next, Previous
  496.  
  497. The Next/Prev buttons allow navigating through the current document using
  498. the keywords. The Next button will find the next keyword in the document
  499. from the current position, scroll if necessary, and highlight the word
  500. with a different color.
  501.  
  502. Document: Next, Previous
  503.  
  504. These commands allow scrolling through the list of documents resulting from
  505. a search in the OasisIII window. The Next/Prev buttons apply to all documents
  506. in the list, regardless of whether a document has been selected or not.
  507. When these buttons are used to traverse the Document list, the list entry
  508. that corresponds to the currently viewed document will be represented in
  509. a different color. Other documents that are displayed, but not in the active
  510. viewer will also be represented in the Document list in yet another color.
  511.  
  512. Active Viewer
  513.  
  514. This toggle indicates which Viewer within the application is considered to
  515. be "active". If this is turned off by clicking on the label, then the next
  516. document will be brought up in it's own window, and that window will now
  517. become the "active viewer".
  518. ________________________________________________________________________
  519.  
  520.  
  521.  
  522.  
  523.  
  524.     OasisIII - Settings Window
  525.     --------------------------------------------------------------------
  526. The Settings window is used to set up the location of the databases to be
  527. used, to set a maximum hit count, to define what a "near" distance is,
  528. to toggle the use of a thesaurus, to set up a printer, etc.
  529.  
  530. Public Path:       Where the OasisIII databases are mounted
  531.  
  532. Fax Server:       Which machine is the fax server for your client
  533.  
  534. Near Distance:       When searching using "[" and "]", the proximity
  535. operators,
  536.            how many characters should be used in computing this
  537.            distance. The default is 72 (~1 line).
  538.  
  539. Maximum Hit Count: Ceiling on the number of documents to return from a
  540.            search. Default is 250. Maximum is 1000.
  541.  
  542. When the Settings window comes up, it shows the default values for each
  543. of the fields that can be set.  Move the mouse pointer to the field you
  544. wish to change, and backspaces over (or cut) the default value, replacing
  545. it with your own value.
  546.  
  547. To toggle thesaurus usage, click the left mouse button on the label titled
  548. "Use Thesaurus?". This will change the color of the toggle box to the left
  549. of the label.
  550.  
  551. To select a printer, click the left mouse button on your choice from the
  552. list provided.
  553.  
  554. When all the selections are made, click the left mouse button on either
  555. the "Save" button to make the changes take effect, or the "Cancel" button
  556. to abort the operation and return to the OasisIII window.
  557. ________________________________________________________________________
  558.  
  559.  
  560.  
  561.  
  562.  
  563.     OasisIII - Folder Manager
  564.     --------------------------------------------------------------------
  565. The purpose of the Folder Manager is to provide alternate entry points
  566. to the data in the OasisIII database. These points are currently Saved
  567. Inquiries and Bookmarks.
  568.  
  569. The Folder allows the user to filter which of the types of entries they
  570. will view, and to invoke or delete these entries from within this window.
  571. ________________________________________________________________________
  572.  
  573.  
  574.  
  575.  
  576.  
  577.     OasisIII - Folder Manager Functions
  578.     --------------------------------------------------------------------
  579. Events
  580.  
  581. You may selectively choose which entry points to view by using the Events
  582. toggle. The default is to display both Saved Inquiries and Bookmarks.
  583. Clicking on the label of these will turn the access to those points on/off,
  584. and the list will dynamically change to reflect the filter criteria.
  585.  
  586. Invoke
  587.  
  588. To invoke an entry point, select (click) an event that appears in the list
  589. displayed by the Folder Manager and then click on the "Invoke" pushbutton.
  590. This can also be performed by double-clicking on the event in the list.
  591.  
  592. Delete
  593.  
  594. An event can be deleted by selecting it from the list and then clicking
  595. the "Delete" pushbutton. Accidental deletions cannot be restored at this
  596. time.
  597. ________________________________________________________________________
  598.